Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc][KubeRay] Add description tables for RayCluster Status in the observability doc #47462

Merged
merged 7 commits into from
Sep 11, 2024

Conversation

rueian
Copy link
Contributor

@rueian rueian commented Sep 3, 2024

KubeRay v1.2.1 comes with new CRD status improvements that are better documented, specifically the new RayClusterStatus.Conditions field.

This PR adds a description table for known values of the new RayClusterStatus.Conditions, letting users know how to interpret them for tracking RayCluster status or debugging.
Another table for the old RayClusterStatus.State is also added to this PR so users can compare the differences between these two fields.

Preview: https://anyscale-ray--47462.com.readthedocs.build/en/47462/cluster/kubernetes/user-guides/observability.html
image

@rueian rueian marked this pull request as ready for review September 3, 2024 16:13
@rueian
Copy link
Contributor Author

rueian commented Sep 3, 2024

Hi @kevin85421, could you take a look?

@kevin85421 kevin85421 added the kuberay Issues for the Ray/Kuberay integration that are tracked on the Ray side label Sep 3, 2024
@kevin85421 kevin85421 self-assigned this Sep 3, 2024
@anyscalesam anyscalesam added P1 Issue that should be fixed within a few weeks core Issues that should be addressed in Ray Core labels Sep 3, 2024
@rueian
Copy link
Contributor Author

rueian commented Sep 4, 2024

Updated:
image




#### RayCluster `.Status.Conditions`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I remember that .Status.Conditions has a feature flag. Can you explain how to enable this feature?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might help also add a warning header here that it's an alpha feature

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both added.

image

Copy link
Contributor

@angelinalg angelinalg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some style nits. Please consider using Vale to find these issues in the future. Please excuse any inaccuracies I introduced in my suggestions and correct as needed. Happy to answer any questions you have about the suggestions. Thanks for your contribution!

doc/source/cluster/kubernetes/user-guides/observability.md Outdated Show resolved Hide resolved
doc/source/cluster/kubernetes/user-guides/observability.md Outdated Show resolved Hide resolved
doc/source/cluster/kubernetes/user-guides/observability.md Outdated Show resolved Hide resolved
doc/source/cluster/kubernetes/user-guides/observability.md Outdated Show resolved Hide resolved
doc/source/cluster/kubernetes/user-guides/observability.md Outdated Show resolved Hide resolved
doc/source/cluster/kubernetes/user-guides/observability.md Outdated Show resolved Hide resolved
doc/source/cluster/kubernetes/user-guides/observability.md Outdated Show resolved Hide resolved
doc/source/cluster/kubernetes/user-guides/observability.md Outdated Show resolved Hide resolved
doc/source/cluster/kubernetes/user-guides/observability.md Outdated Show resolved Hide resolved
doc/source/cluster/kubernetes/user-guides/observability.md Outdated Show resolved Hide resolved
@rueian
Copy link
Contributor Author

rueian commented Sep 10, 2024

Hi @angelinalg, thank you so much for reviewing. All suggestions are applied.

@kevin85421 kevin85421 added the go add ONLY when ready to merge, run all tests label Sep 10, 2024
@jjyao jjyao merged commit 8e62414 into ray-project:master Sep 11, 2024
6 checks passed
ujjawal-khare pushed a commit to ujjawal-khare-27/ray that referenced this pull request Oct 15, 2024
ujjawal-khare pushed a commit to ujjawal-khare-27/ray that referenced this pull request Oct 15, 2024
ujjawal-khare pushed a commit to ujjawal-khare-27/ray that referenced this pull request Oct 15, 2024
ujjawal-khare pushed a commit to ujjawal-khare-27/ray that referenced this pull request Oct 15, 2024
ujjawal-khare pushed a commit to ujjawal-khare-27/ray that referenced this pull request Oct 15, 2024
ujjawal-khare pushed a commit to ujjawal-khare-27/ray that referenced this pull request Oct 15, 2024
ujjawal-khare pushed a commit to ujjawal-khare-27/ray that referenced this pull request Oct 15, 2024
ujjawal-khare pushed a commit to ujjawal-khare-27/ray that referenced this pull request Oct 15, 2024
ujjawal-khare pushed a commit to ujjawal-khare-27/ray that referenced this pull request Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Issues that should be addressed in Ray Core go add ONLY when ready to merge, run all tests kuberay Issues for the Ray/Kuberay integration that are tracked on the Ray side P1 Issue that should be fixed within a few weeks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants